Update article settings.
- 12 May 2026
- 12 Minutes to read
- Contributors
- Print
- DarkLight
Update article settings.
- Updated on 12 May 2026
- 12 Minutes to read
- Contributors
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Patch
/v3/projects/{project_id}/articles/{article_id}/settings
Performs a partial update of article settings — only fields included in the request body are modified; omitted fields remain unchanged. Supports updating SEO metadata (slug, title, description), visibility flags (exclude from search, allow comments), tags, status indicators, related articles, and content type. Requires UpdateArticles permission and ACL access to the article.
Security
OAuth
All V3 endpoints require a Bearer token. Generate tokens in the Document360 portal under Settings > API Tokens. Tokens are project-scoped, require the customerApi scope, and do not expire by default. Tokens can be revoked at any time from the portal. Include the token in every request: Authorization: Bearer <your-token>. Alternatively, use the Authorize button below to sign in via OAuth2 Authorization Code flow with PKCE.
FlowAuthorization Code
Authorization URLhttps://identity.document360.net/connect/authorize
Token URLhttps://identity.document360.net/connect/token
Scopes:
customerApiDocument360 Customer API
Path parameters
project_id
string (uuid) Required
The unique identifier of the project. Retrieve project IDs from GET /v3/projects.
Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d
article_id
string (uuid) Required
The unique identifier of the article. Retrieve article IDs from GET /v3/projects/{project_id}/articles.
Example9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d
Query parameters
lang_code
string
ISO 639-1 language code (e.g., en, fr). Defaults to the project's primary language if omitted.
Pattern^[a-z]{2}(-[A-Z]{2})?$
Exampleen
Body parameters
Updated article settings.
Update SEO and tags
Updates the SEO title, meta description, and tags for better search engine visibility.
{
"slug": "getting-started-with-single-sign-on",
"seo_title": "SSO Setup Guide - Product Documentation",
"description": "Step-by-step instructions for configuring single sign-on with SAML or OIDC providers.",
"allow_comments": null,
"show_table_of_contents": null,
"tags": [
"SSO",
"authentication",
"SAML",
"OIDC"
],
"status_indicator": null,
"status_indicator_expiry_date": null,
"exclude_from_search": null,
"exclude_from_ai_search": null,
"exclude_from_external_search": null,
"related_articles": null,
"content_type": null,
"is_acknowledgement_enabled": null
}Add status indicator and related articles
Marks the article as updated and links related articles for cross-referencing.
{
"slug": null,
"seo_title": null,
"description": null,
"allow_comments": null,
"show_table_of_contents": null,
"tags": null,
"status_indicator": "updated",
"status_indicator_expiry_date": "2025-12-31T23:59:59Z",
"exclude_from_search": null,
"exclude_from_ai_search": null,
"exclude_from_external_search": null,
"related_articles": [
"c5d6e7f8-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
"e7f8a9b0-1c2d-3e4f-5a6b-7c8d9e0f1a2b"
],
"content_type": null,
"is_acknowledgement_enabled": null
}object
Request to update article settings.
seo_title
string | null
The custom SEO title for search engines.
ExampleSSO Setup Guide - Product Documentation
description
string | null
The meta description for search engines.
ExampleStep-by-step instructions for configuring single sign-on with SAML or OIDC providers.
allow_comments
boolean | null
Whether reader comments are allowed on the article.
Exampletrue
show_table_of_contents
boolean | null
Whether the table of contents is displayed.
Exampletrue
tags
Array of string | null
The list of tags to associate with the article.
string
status_indicator
string | null
The status indicator badge to display on the article. Possible values: 0 = None, 1 = New, 2 = Updated, 3 = Custom.
Valid values[ "none", "new", "updated", "custom" ]
status_indicator_expiry_date
string (date-time) | null
The expiry date for the status indicator badge. Only applicable when StatusIndicator is set.
Example2025-12-31T23:59:59Z
exclude_from_search
boolean | null
Whether to exclude the article from internal search results.
Examplefalse
exclude_from_ai_search
boolean | null
Whether to exclude the article from AI-powered search.
Examplefalse
exclude_from_external_search
boolean | null
Whether to exclude the article from external search engine indexing.
Examplefalse
related_articles
Array of string | null
The list of related article identifiers to link. Supply article IDs as strings; the corresponding GET response returns enriched objects with title, slug, and visibility. Retrieve article IDs from GET /v3/projects/{projectId}/articles.
string
content_type
string | null
The editor content type for the article. Possible values: 0 = Markdown, 1 = Wysiwyg (rich text), 2 = Block.
Valid values[ "markdown", "wysiwyg", "block" ]
is_acknowledgement_enabled
boolean | null
Whether reader acknowledgement is required for this article.
Examplefalse
Responses
200
Article settings updated successfully.
Settings updated successfully
The article settings have been updated. Only the fields included in the request were modified.
{
"data": {
"slug": "getting-started-with-single-sign-on",
"seo_title": "SSO Setup Guide - Product Documentation",
"description": "Step-by-step instructions for configuring single sign-on with SAML or OIDC providers.",
"allow_comments": true,
"show_table_of_contents": true,
"featured_image_url": null,
"tags": [
"SSO",
"authentication",
"SAML",
"OIDC"
],
"status_indicator": "updated",
"status_indicator_expiry_date": "2025-12-31T23:59:59Z",
"exclude_from_search": false,
"exclude_from_ai_search": false,
"exclude_from_external_search": false,
"related_articles": [
{
"id": "c5d6e7f8-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
"title": "Configuring SAML Identity Providers",
"hidden": false,
"slug": "configuring-saml-identity-providers"
}
],
"is_acknowledgement_enabled": false,
"url": "https://docs.example.com/en/articles/getting-started-with-single-sign-on"
},
"success": true,
"request_id": "req_abc123def456",
"errors": null,
"warnings": null
}object
Generic API response wrapper containing typed data.
data
object
Response data payload.
slug
string | null
The URL slug for the article.
Examplegetting-started-with-single-sign-on
seo_title
string | null
The custom SEO title for search engines.
ExampleSSO Setup Guide - Product Documentation
description
string | null
The meta description for search engines.
ExampleStep-by-step instructions for configuring single sign-on with SAML or OIDC providers.
allow_comments
boolean
Whether reader comments are allowed on the article.
Exampletrue
show_table_of_contents
boolean
Whether the table of contents is displayed.
Exampletrue
featured_image_url
string | null
The URL of the featured image for the article. For private or mixed-visibility projects, a time-limited SAS token is automatically appended. Read-only; the featured image can only be set via the Document360 portal.
Examplehttps://cdn.example.com/images/sso-hero-banner.png
tags
Array of string | null
The list of tags associated with the article.
string
status_indicator
string
The status indicator badge shown on the article. Possible values: 0 = None, 1 = New, 2 = Updated, 3 = Custom.
Valid values[ "none", "new", "updated", "custom" ]
status_indicator_expiry_date
string (date-time) | null
The expiry date for the status indicator badge. Only applicable when StatusIndicator is set.
Example2025-12-31T23:59:59Z
exclude_from_search
boolean
Whether the article is excluded from internal search results.
Examplefalse
exclude_from_ai_search
boolean
Whether the article is excluded from AI-powered search.
Examplefalse
exclude_from_external_search
boolean
Whether the article is excluded from external search engine indexing.
Examplefalse
related_articles
Array of object (RelatedArticle) | null
The list of related articles linked to this article, returned as enriched objects. When updating via PATCH, supply only article IDs as strings.
object
A related article linked from another article's settings.
id
string (uuid) | null
The unique identifier of the related article.
Examplec5d6e7f8-9a0b-1c2d-3e4f-5a6b7c8d9e0f
title
string | null
The title of the related article.
ExampleConfiguring SAML Identity Providers
hidden
boolean
Whether the related article is hidden from readers.
Examplefalse
slug
string | null
The URL slug of the related article.
Exampleconfiguring-saml-identity-providers
is_acknowledgement_enabled
boolean
Whether reader acknowledgement is required for this article.
Examplefalse
url
string (uri) | null
The full URL of the article.
Examplehttps://docs.example.com/en/articles/getting-started-with-single-sign-on
success
boolean
Whether the API request was successful.
request_id
string
Unique identifier for request tracing and correlation.
Min length1
errors
Array of object (ApiError) | null
List of errors if the request failed.
object
Represents an error returned by the API.
code
string
Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).
Min length1
message
string
Human-readable error message.
Min length1
field
string | null
The request field that caused the error, if applicable.
details
string | null
Additional context about the error.
warnings
Array of object (ApiWarning) | null
List of non-fatal warnings from the request.
object
Represents a non-fatal warning from the API.
code
string
Machine-readable warning code.
Min length1
message
string
Human-readable warning message.
Min length1
400
The request body is malformed or contains invalid JSON.
object
RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json
type
string
URI reference identifying the error type (links to documentation).
Min length1
title
string
Short human-readable summary of the error type.
Min length1
status
integer (int32)
HTTP status code.
detail
string | null
Human-readable explanation specific to this occurrence.
instance
string | null
URI of the request that generated the error.
trace_id
string | null
Request trace identifier for correlation.
errors
Array of object (ApiError) | null
Structured list of specific errors (extension field).
object
Represents an error returned by the API.
code
string
Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).
Min length1
message
string
Human-readable error message.
Min length1
field
string | null
The request field that caused the error, if applicable.
details
string | null
Additional context about the error.
warnings
Array of object (ApiWarning) | null
Non-fatal warnings (extension field).
object
Represents a non-fatal warning from the API.
code
string
Machine-readable warning code.
Min length1
message
string
Human-readable warning message.
Min length1
401
Authentication token is missing or invalid.
Headers
WWW-Authenticate
string
Indicates the authentication scheme required. Returns `Bearer` with optional `error` and `error_description` parameters per RFC 6750.
Missing or invalid token
Authentication token is missing or invalid.
{
"type": "https://developer.document360.com/errors/unauthorized",
"title": "Unauthorized.",
"status": 401,
"detail": "The authentication token is missing or has expired.",
"instance": null,
"trace_id": "req_abc123def456",
"errors": [
{
"code": "UNAUTHORIZED",
"message": "Bearer token is missing or invalid.",
"field": null,
"details": null
}
],
"warnings": null
}object
RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json
type
string
URI reference identifying the error type (links to documentation).
Min length1
title
string
Short human-readable summary of the error type.
Min length1
status
integer (int32)
HTTP status code.
detail
string | null
Human-readable explanation specific to this occurrence.
instance
string | null
URI of the request that generated the error.
trace_id
string | null
Request trace identifier for correlation.
errors
Array of object (ApiError) | null
Structured list of specific errors (extension field).
object
Represents an error returned by the API.
code
string
Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).
Min length1
message
string
Human-readable error message.
Min length1
field
string | null
The request field that caused the error, if applicable.
details
string | null
Additional context about the error.
warnings
Array of object (ApiWarning) | null
Non-fatal warnings (extension field).
object
Represents a non-fatal warning from the API.
code
string
Machine-readable warning code.
Min length1
message
string
Human-readable warning message.
Min length1
404
Article not found.
Resource not found
The requested resource was not found.
{
"type": "https://developer.document360.com/errors/not-found",
"title": "Not Found.",
"status": 404,
"detail": "The requested resource does not exist or has been deleted.",
"instance": null,
"trace_id": "req_abc123def456",
"errors": [
{
"code": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found.",
"field": null,
"details": null
}
],
"warnings": null
}object
RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json
type
string
URI reference identifying the error type (links to documentation).
Min length1
title
string
Short human-readable summary of the error type.
Min length1
status
integer (int32)
HTTP status code.
detail
string | null
Human-readable explanation specific to this occurrence.
instance
string | null
URI of the request that generated the error.
trace_id
string | null
Request trace identifier for correlation.
errors
Array of object (ApiError) | null
Structured list of specific errors (extension field).
object
Represents an error returned by the API.
code
string
Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).
Min length1
message
string
Human-readable error message.
Min length1
field
string | null
The request field that caused the error, if applicable.
details
string | null
Additional context about the error.
warnings
Array of object (ApiWarning) | null
Non-fatal warnings (extension field).
object
Represents a non-fatal warning from the API.
code
string
Machine-readable warning code.
Min length1
message
string
Human-readable warning message.
Min length1
422
Validation failed.
Validation failed
The request body contains invalid data.
{
"type": "https://developer.document360.com/errors/validation-error",
"title": "Unprocessable Entity.",
"status": 422,
"detail": "One or more fields failed validation.",
"instance": null,
"trace_id": "req_abc123def456",
"errors": [
{
"code": "VALIDATION_ERROR",
"message": "This field is required.",
"field": "title",
"details": null
}
],
"warnings": null
}object
RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json
type
string
URI reference identifying the error type (links to documentation).
Min length1
title
string
Short human-readable summary of the error type.
Min length1
status
integer (int32)
HTTP status code.
detail
string | null
Human-readable explanation specific to this occurrence.
instance
string | null
URI of the request that generated the error.
trace_id
string | null
Request trace identifier for correlation.
errors
Array of object (ApiError) | null
Structured list of specific errors (extension field).
object
Represents an error returned by the API.
code
string
Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).
Min length1
message
string
Human-readable error message.
Min length1
field
string | null
The request field that caused the error, if applicable.
details
string | null
Additional context about the error.
warnings
Array of object (ApiWarning) | null
Non-fatal warnings (extension field).
object
Represents a non-fatal warning from the API.
code
string
Machine-readable warning code.
Min length1
message
string
Human-readable warning message.
Min length1
429
Rate limit exceeded. Retry after the duration specified in the Retry-After header.
Headers
Retry-After
integer
Number of seconds to wait before retrying the request. Use exponential backoff with jitter for optimal retry behavior.
X-RateLimit-Limit
integer
The maximum number of requests allowed in the current time window. Limits are applied per API token per project.
X-RateLimit-Remaining
integer
The number of requests remaining in the current time window. When this reaches 0, subsequent requests will receive a 429 response.
X-RateLimit-Reset
integer
The UTC epoch timestamp (in seconds) when the current rate limit window resets.
Rate limit exceeded
Rate limit exceeded.
{
"type": "https://developer.document360.com/errors/too-many-requests",
"title": "Too Many Requests.",
"status": 429,
"detail": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
"instance": null,
"trace_id": "req_abc123def456",
"errors": [
{
"code": "TOO_MANY_REQUESTS",
"message": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
"field": null,
"details": null
}
],
"warnings": null
}object
RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json
type
string
URI reference identifying the error type (links to documentation).
Min length1
title
string
Short human-readable summary of the error type.
Min length1
status
integer (int32)
HTTP status code.
detail
string | null
Human-readable explanation specific to this occurrence.
instance
string | null
URI of the request that generated the error.
trace_id
string | null
Request trace identifier for correlation.
errors
Array of object (ApiError) | null
Structured list of specific errors (extension field).
object
Represents an error returned by the API.
code
string
Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).
Min length1
message
string
Human-readable error message.
Min length1
field
string | null
The request field that caused the error, if applicable.
details
string | null
Additional context about the error.
warnings
Array of object (ApiWarning) | null
Non-fatal warnings (extension field).
object
Represents a non-fatal warning from the API.
code
string
Machine-readable warning code.
Min length1
message
string
Human-readable warning message.
Min length1
500
An unexpected server error occurred.
Unexpected server error
Unexpected server error.
{
"type": "https://developer.document360.com/errors/internal-error",
"title": "Internal Server Error.",
"status": 500,
"detail": "An unexpected error occurred. Please try again or contact support.",
"instance": null,
"trace_id": "req_abc123def456",
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred.",
"field": null,
"details": null
}
],
"warnings": null
}object
RFC 7807 Problem Details response for V3 API errors. Content-Type: application/problem+json
type
string
URI reference identifying the error type (links to documentation).
Min length1
title
string
Short human-readable summary of the error type.
Min length1
status
integer (int32)
HTTP status code.
detail
string | null
Human-readable explanation specific to this occurrence.
instance
string | null
URI of the request that generated the error.
trace_id
string | null
Request trace identifier for correlation.
errors
Array of object (ApiError) | null
Structured list of specific errors (extension field).
object
Represents an error returned by the API.
code
string
Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND).
Min length1
message
string
Human-readable error message.
Min length1
field
string | null
The request field that caused the error, if applicable.
details
string | null
Additional context about the error.
warnings
Array of object (ApiWarning) | null
Non-fatal warnings (extension field).
object
Represents a non-fatal warning from the API.
code
string
Machine-readable warning code.
Min length1
message
string
Human-readable warning message.
Min length1
Was this article helpful?
